home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / DJGPP / DJLSR111.ZIP / libsrc / c / gen / alloca.c next >
C/C++ Source or Header  |  1993-10-09  |  4KB  |  142 lines
  1. /* alloca.c -- allocate automatically reclaimed memory
  2.    (Mostly) portable public-domain implementation -- D A Gwyn
  3.  
  4.    This implementation of the PWB library alloca function,
  5.    which is used to allocate space off the run-time stack so
  6.    that it is automatically reclaimed upon procedure exit,
  7.    was inspired by discussions with J. Q. Johnson of Cornell.
  8.    J.Otto Tennant <jot@cray.com> contributed the Cray support.
  9.  
  10.    There are some preprocessor constants that can
  11.    be defined when compiling for your specific system, for
  12.    improved efficiency; however, the defaults should be okay.
  13.  
  14.    The general concept of this implementation is to keep
  15.    track of all alloca-allocated blocks, and reclaim any
  16.    that are found to be deeper in the stack than the current
  17.    invocation.  This heuristic does not reclaim storage as
  18.    soon as it becomes invalid, but it will do so eventually.
  19.  
  20.    As a special case, alloca(0) reclaims storage without
  21.    allocating any.  It is a good idea to use alloca(0) in
  22.    your main control loop, etc. to force garbage collection.  */
  23.  
  24. #ifdef alloca
  25. #undef alloca
  26. #endif
  27.  
  28. /* If your stack is a linked list of frames, you have to
  29.    provide an "address metric" ADDRESS_FUNCTION macro.  */
  30.  
  31. #define ADDRESS_FUNCTION(arg) &(arg)
  32.  
  33. typedef void *pointer;
  34.  
  35. #define    NULL    0
  36.  
  37. /* Different portions of Emacs need to call different versions of
  38.    malloc.  The Emacs executable needs alloca to call xmalloc, because
  39.    ordinary malloc isn't protected from input signals.  On the other
  40.    hand, the utilities in lib-src need alloca to call malloc; some of
  41.    them are very simple, and don't have an xmalloc routine.
  42.  
  43.    Non-Emacs programs expect this to call use xmalloc.
  44.  
  45.    Callers below should use malloc.  */
  46.  
  47.  
  48. #define malloc xmalloc
  49.  
  50. extern pointer malloc ();
  51.  
  52. /* Define STACK_DIRECTION if you know the direction of stack
  53.    growth for your system; otherwise it will be automatically
  54.    deduced at run-time.
  55.  
  56.    STACK_DIRECTION > 0 => grows toward higher addresses
  57.    STACK_DIRECTION < 0 => grows toward lower addresses
  58.    STACK_DIRECTION = 0 => direction of growth unknown  */
  59.  
  60. #define    STACK_DIRECTION    -1    /* Direction unknown.  */
  61.  
  62. #define    STACK_DIR    STACK_DIRECTION    /* Known at compile-time.  */
  63.  
  64. /* An "alloca header" is used to:
  65.    (a) chain together all alloca'ed blocks;
  66.    (b) keep track of stack depth.
  67.  
  68.    It is very important that sizeof(header) agree with malloc
  69.    alignment chunk size.  The following default should work okay.  */
  70.  
  71. #ifndef    ALIGN_SIZE
  72. #define    ALIGN_SIZE    sizeof(double)
  73. #endif
  74.  
  75. typedef union hdr
  76. {
  77.   char align[ALIGN_SIZE];    /* To force sizeof(header).  */
  78.   struct
  79.     {
  80.       union hdr *next;        /* For chaining headers.  */
  81.       char *deep;        /* For stack depth measure.  */
  82.     } h;
  83. } header;
  84.  
  85. static header *last_alloca_header = NULL;    /* -> last alloca header.  */
  86.  
  87. /* Return a pointer to at least SIZE bytes of storage,
  88.    which will be automatically reclaimed upon exit from
  89.    the procedure that called alloca.  Originally, this space
  90.    was supposed to be taken from the current stack frame of the
  91.    caller, but that method cannot be made to work for some
  92.    implementations of C, for example under Gould's UTX/32.  */
  93.  
  94. pointer
  95. alloca (size)
  96.      unsigned size;
  97. {
  98.   auto char probe;        /* Probes stack depth: */
  99.   register char *depth = ADDRESS_FUNCTION (probe);
  100.  
  101.   /* Reclaim garbage, defined as all alloca'd storage that
  102.      was allocated from deeper in the stack than currently. */
  103.  
  104.   {
  105.     register header *hp;    /* Traverses linked list.  */
  106.  
  107.     for (hp = last_alloca_header; hp != NULL;)
  108.       if ((STACK_DIR > 0 && hp->h.deep > depth)
  109.       || (STACK_DIR < 0 && hp->h.deep < depth))
  110.     {
  111.       register header *np = hp->h.next;
  112.  
  113.       free ((pointer) hp);    /* Collect garbage.  */
  114.  
  115.       hp = np;        /* -> next header.  */
  116.     }
  117.       else
  118.     break;            /* Rest are not deeper.  */
  119.  
  120.     last_alloca_header = hp;    /* -> last valid storage.  */
  121.   }
  122.  
  123.   if (size == 0)
  124.     return NULL;        /* No allocation required.  */
  125.  
  126.   /* Allocate combined header + user data storage.  */
  127.  
  128.   {
  129.     register pointer new = malloc (sizeof (header) + size);
  130.     /* Address of header.  */
  131.  
  132.     ((header *) new)->h.next = last_alloca_header;
  133.     ((header *) new)->h.deep = depth;
  134.  
  135.     last_alloca_header = (header *) new;
  136.  
  137.     /* User storage begins just after header.  */
  138.  
  139.     return (pointer) ((char *) new + sizeof (header));
  140.   }
  141. }
  142.